<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: soe_request.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('soe__request_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">soe_request.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>EtherCAT SoE request structure.  
<a href="#details">More...</a></p>

<p><a href="soe__request_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sercos-over-EtherCAT request.  <a href="structec__soe__request__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a153a97cf0b6f06a25566bced679a548f"><td class="memItemLeft" align="right" valign="top"><a id="a153a97cf0b6f06a25566bced679a548f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a153a97cf0b6f06a25566bced679a548f">ec_soe_request_init</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *)</td></tr>
<tr class="memdesc:a153a97cf0b6f06a25566bced679a548f"><td class="mdescLeft">&#160;</td><td class="mdescRight">SoE request constructor. <br /></td></tr>
<tr class="separator:a153a97cf0b6f06a25566bced679a548f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62db42f000afec347cb9abeef113e06c"><td class="memItemLeft" align="right" valign="top"><a id="a62db42f000afec347cb9abeef113e06c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a62db42f000afec347cb9abeef113e06c">ec_soe_request_clear</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *)</td></tr>
<tr class="memdesc:a62db42f000afec347cb9abeef113e06c"><td class="mdescLeft">&#160;</td><td class="mdescRight">SoE request destructor. <br /></td></tr>
<tr class="separator:a62db42f000afec347cb9abeef113e06c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af86daad102b4c9882a1efa9a586c601b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#af86daad102b4c9882a1efa9a586c601b">ec_soe_request_copy</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *, const <a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *)</td></tr>
<tr class="memdesc:af86daad102b4c9882a1efa9a586c601b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy another SoE request.  <a href="#af86daad102b4c9882a1efa9a586c601b">More...</a><br /></td></tr>
<tr class="separator:af86daad102b4c9882a1efa9a586c601b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31de21e8095a24e03eb4a5e5662f7d66"><td class="memItemLeft" align="right" valign="top"><a id="a31de21e8095a24e03eb4a5e5662f7d66"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a31de21e8095a24e03eb4a5e5662f7d66">ec_soe_request_set_drive_no</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *, uint8_t)</td></tr>
<tr class="memdesc:a31de21e8095a24e03eb4a5e5662f7d66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set drive number. <br /></td></tr>
<tr class="separator:a31de21e8095a24e03eb4a5e5662f7d66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4779a40d4914431cfe445423ae85ff31"><td class="memItemLeft" align="right" valign="top"><a id="a4779a40d4914431cfe445423ae85ff31"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a4779a40d4914431cfe445423ae85ff31">ec_soe_request_set_idn</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *, uint16_t)</td></tr>
<tr class="memdesc:a4779a40d4914431cfe445423ae85ff31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set IDN. <br /></td></tr>
<tr class="separator:a4779a40d4914431cfe445423ae85ff31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56a1ad50edce8aa012dc5e14fa395e33"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a56a1ad50edce8aa012dc5e14fa395e33">ec_soe_request_alloc</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *, size_t)</td></tr>
<tr class="memdesc:a56a1ad50edce8aa012dc5e14fa395e33"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pre-allocates the data memory.  <a href="#a56a1ad50edce8aa012dc5e14fa395e33">More...</a><br /></td></tr>
<tr class="separator:a56a1ad50edce8aa012dc5e14fa395e33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95c77d9ede649345d55f6e1dacf65cb3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a95c77d9ede649345d55f6e1dacf65cb3">ec_soe_request_copy_data</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *, const uint8_t *, size_t)</td></tr>
<tr class="memdesc:a95c77d9ede649345d55f6e1dacf65cb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies SoE data from an external source.  <a href="#a95c77d9ede649345d55f6e1dacf65cb3">More...</a><br /></td></tr>
<tr class="separator:a95c77d9ede649345d55f6e1dacf65cb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a436096a029ec15737fa4a363247d037a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a436096a029ec15737fa4a363247d037a">ec_soe_request_append_data</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *, const uint8_t *, size_t)</td></tr>
<tr class="memdesc:a436096a029ec15737fa4a363247d037a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies SoE data from an external source.  <a href="#a436096a029ec15737fa4a363247d037a">More...</a><br /></td></tr>
<tr class="separator:a436096a029ec15737fa4a363247d037a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68954a5a60ba8dc64abb442be9481e67"><td class="memItemLeft" align="right" valign="top"><a id="a68954a5a60ba8dc64abb442be9481e67"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a68954a5a60ba8dc64abb442be9481e67">ec_soe_request_read</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *)</td></tr>
<tr class="memdesc:a68954a5a60ba8dc64abb442be9481e67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request a read operation. <br /></td></tr>
<tr class="separator:a68954a5a60ba8dc64abb442be9481e67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aaef8f08907e15aad18c6b72995fec9"><td class="memItemLeft" align="right" valign="top"><a id="a3aaef8f08907e15aad18c6b72995fec9"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soe__request_8h.html#a3aaef8f08907e15aad18c6b72995fec9">ec_soe_request_write</a> (<a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *)</td></tr>
<tr class="memdesc:a3aaef8f08907e15aad18c6b72995fec9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request a write operation. <br /></td></tr>
<tr class="separator:a3aaef8f08907e15aad18c6b72995fec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>EtherCAT SoE request structure. </p>

<p class="definition">Definition in file <a class="el" href="soe__request_8h_source.html">soe_request.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="af86daad102b4c9882a1efa9a586c601b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af86daad102b4c9882a1efa9a586c601b">&#9670;&nbsp;</a></span>ec_soe_request_copy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_soe_request_copy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *&#160;</td>
          <td class="paramname"><em>req</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *&#160;</td>
          <td class="paramname"><em>other</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy another SoE request. </p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">req</td><td>SoE request. </td></tr>
    <tr><td class="paramname">other</td><td>Other SoE request to copy from. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="soe__request_8c_source.html#l00090">90</a> of file <a class="el" href="soe__request_8c_source.html">soe_request.c</a>.</p>

</div>
</div>
<a id="a56a1ad50edce8aa012dc5e14fa395e33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56a1ad50edce8aa012dc5e14fa395e33">&#9670;&nbsp;</a></span>ec_soe_request_alloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_soe_request_alloc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *&#160;</td>
          <td class="paramname"><em>req</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pre-allocates the data memory. </p>
<p>If the <em>mem_size</em> is already bigger than <em>size</em>, nothing is done.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success, otherwise -ENOMEM. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">req</td><td>SoE request. </td></tr>
    <tr><td class="paramname">size</td><td>Data size to allocate. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="soe__request_8c_source.html#l00150">150</a> of file <a class="el" href="soe__request_8c_source.html">soe_request.c</a>.</p>

</div>
</div>
<a id="a95c77d9ede649345d55f6e1dacf65cb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95c77d9ede649345d55f6e1dacf65cb3">&#9670;&nbsp;</a></span>ec_soe_request_copy_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_soe_request_copy_data </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *&#160;</td>
          <td class="paramname"><em>req</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>source</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copies SoE data from an external source. </p>
<p>If the <em>mem_size</em> is to small, new memory is allocated.</p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>Success. </td></tr>
    <tr><td class="paramname">&lt;0</td><td>Error code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">req</td><td>SoE request. </td></tr>
    <tr><td class="paramname">source</td><td>Source data. </td></tr>
    <tr><td class="paramname">size</td><td>Number of bytes in <em>source</em>. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="soe__request_8c_source.html#l00179">179</a> of file <a class="el" href="soe__request_8c_source.html">soe_request.c</a>.</p>

</div>
</div>
<a id="a436096a029ec15737fa4a363247d037a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a436096a029ec15737fa4a363247d037a">&#9670;&nbsp;</a></span>ec_soe_request_append_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_soe_request_append_data </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__soe__request__t.html">ec_soe_request_t</a> *&#160;</td>
          <td class="paramname"><em>req</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>source</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copies SoE data from an external source. </p>
<p>If the <em>mem_size</em> is to small, new memory is allocated.</p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>Success. </td></tr>
    <tr><td class="paramname">&lt;0</td><td>Error code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">req</td><td>SoE request. </td></tr>
    <tr><td class="paramname">source</td><td>Source data. </td></tr>
    <tr><td class="paramname">size</td><td>Number of bytes in <em>source</em>. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="soe__request_8c_source.html#l00203">203</a> of file <a class="el" href="soe__request_8c_source.html">soe_request.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="soe__request_8h.html">soe_request.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
